// THIS IS MODULE SHEEPLE FUNCTION API

// PHP FUNCTIONS LIB.PHP

/**
* will be called during the installation of the module
* @return true
*/
function sheeple_install() 


/**
* code to add a new instance of widget
* @param sheeple instance
* @return int (index)
*/
function sheeple_add_instance($sheeple) 

/**
* code to update an existing instance 
* @param sheeple: groupassignment instance
* @return Boolean
*/
function sheeple_update_instance($sheeple) 


/**
* This code deletes instance of groupassignment
*   and groups referring to this instance
*   and groupmembers from these groups
*   and submissions made by these groups
*
* @param int: groupassignmentid
* @return Boolean
*/
function sheeple_delete_instance($id) 


/**
* given an instance, return a summary of a user's contribution
* Required by Moodle
* @return 
*/
function sheeple_user_outline() 


/**
* given an instance, print details of a user's contribution
* Required by Moodle
* @return true
*/
function sheeple_user_complete() 


/**
* Used by the participation report (course/report/participation/index.php) to classify actions in the logs table.
* Required by Moodle
* @return true
*/
function sheeple_get_view_actions() 


/** 
* Code to clean up anything that would be leftover after all instances are deleted
* Required by moodle
* @return true
*/
function sheeple_delete_course() 


/**
*This function returns groupassignments in selected course
* @param int: courseid
* @return Boolean
*/
function sheeple_get_groupassignments($courseid) 


/**
* This function returns selected groupassignment in selected course
* @param int: courseid
* @param int: groupassignmentid
* @return groupassignment instance
*/
function sheeple_get_groupassignment($courseid, $groupassignmentid) 


/**
* This function returns selected group as array indexed by column name
* @param int: groupid
* @return array() group
*/
function sheeple_get_group($groupid) 

/**
* This function returns selected groupassignments groups
* @param int: groupassignmentid
* @return: group instances referring to this instance
*/
function sheeple_get_group_array($groupassignmentid) 


/**
* This function returns selected groups name at given index
* @param int: groupid
* @return: groupname
*/
function sheeple_get_groupname($groupid) 

 
/**
* This function returns selected groups profile array
* @param int: groupid
* @return array() group profile
*/
function sheeple_get_groupprofile($groupid) 


/**
* This function returns submissionname for given type number
* @param int: submission type id from table "sheeple"
* @return string: submission type name
*/
function sheeple_get_submissionname($subtype) 


/** 
* This function returns submission for given type number
* @param int: groupid
* @param string: submission name
* @return array() submission
*/
function sheeple_get_submission($groupid, $subname) 


/**
* This function checks if student is member of given group
* @param int: groupid
* @param int: userid
* @return Boolean
*/
function sheeple_memberofgroup ($groupid, $userid) 


/**
* This function checks if student is member of group in this groupassignment
* @param int: groupassignmentid
* @param int: userid
* @return int: groupid
*/
function sheeple_alreadymember ($groupassignmentid, $userid) 


/**
* This function removes student from given group
* @param int: groupid
* @param int: userid
* @return Boolean
*/
function sheeple_resign_group ($groupid, $userid) 


/**
* This function adds group to given groupassignment
* @param int: groupassignmentid
* @param String: name
* @param String: Desc
* @return Boolean
*/
function sheeple_add_group($groupassignmentid, $name, $desc) 


/**
* This function updates group profile
* @param int: groupid
* @param int: groupassignmentid
* @param String: name 
* @param String: desc
* @return Boolean
*/
function sheeple_update_group($groupid, $groupassignmentid, $name, $desc) 

/**
* This function returns MAX(id) from group table, used when joining group after saving
* @param int: groupassignmentid
* @param String: name
* @param String: desc
* @return int
*/
function sheeple_get_groupidmax($groupassignmentid, $name, $desc) 


/**
* This function adds student to a group
* @param int: groupassignmentid
* @param int: groupid
* @param int: userid
* @return Boolean
*/
function sheeple_join_group($groupassignmentid, $groupid, $userid) 

	
/**
* This function deletes group.
* @param int: submissiontype
* @param int: groupid
* @return Boolean
*/
function sheeple_delete_group($submissiontype, $groupid) 

/**
* This function returns students who are members of given group (Ajax)
* @param int: groupid
* @return string array()
*/   
function sheeple_get_membersarray($groupid) 


/**
* Function for drawing header.
*
*
* @param navigation links array and course
* @return draws header
*/

function view_header($navlinks,$course)


/**
* Updates and creates grading for students.
*
* @param groupassignment and grading values
* @return
*/
function update_grade_item($sheeple,$grades=NULL) 


/**
* Function returns students for given group
*
* @param groupid
* @return groupmembers array
*/
function get_group_members($groupid)


/**
*
* This function creates grading for student.
*
*
* @param groupassignment, studentid
* @return 
*/
function create_grade_student($sheeple,$userid)

/**
*  This function grades group and groups students.
*
*
* @param groupid, groupassignment, groupgrade, groupfeedback, students array and 
*        students grades
* @return
*/
function gradegroup($groupid,$sheeple,$value,$feedback,$users,$values)


/**
*
* This function updates values for main window when grading group.
*
* @param  groupid,grade,fedback,grading scale
* @return
*/
function update_main_window($id,$groupid,$grade,$feedback,$scale)


/**
* This function reads values when graded students and group and saves values to array.
*
* @param
* @return grades array
*/
function read_grades()


/**
* Function formats groups grade for given scale.
*
* @param scale,groups grade
* @return formatted grade
*/
function get_formatted_grade($scale,$grade)


/**
* This function returns students from given group.
*
* @param groupis
* @return student array
*/
function get_students_for_grading($groupid)


/**
* Function returns data for  group that given student belongs.
*
*
* @param groupassignmentid, student id
* @return group data as array
*/
function get_student_group($assignmentid,$userid)


/**
* Function returns grading for student and students group. 
*
* @param course, groupassignment, studentid
* @return grading
*/
function get_grading($course,$sheeple,$userid)


/**
* Function prints grading user grading.
*
* @param course,groupassignment 
* @return prints grading
*/
function view_feedback($course,$sheeple,$userid)

//JAVASCRIPT FUNCTIONS:
   
/**
* This Ajax function calls getgroup.php in the server
* to get profiles selected from grouplist
* 
* Buttons in group.php and profiles are dynamically controlled
* 
* @param int: groupid
* $param int: course module id
* @return HTML div
*/
function ajaxFunction(getgroup,cm)
   
/**
* Function for enabling button
* @param button
*/
function show(button)
   
/**
* Function for disabling button
* @param button
*/
function hide(button)
   
   
/**
* Function for setting groups grade for students.*
* 
*/
function set_grade_all()